Syntax

Visual Basic (Declaration)
Overloads Public Function Run( _ ByVal fileName As String, _ ByVal categories As List(Of IMasterFormsCategory) _ ) As AutoFormsRunResult

Visual Basic (Usage)	Copy Code
`Dim instance As AutoFormsEngine Dim fileName As String Dim categories As List(Of IMasterFormsCategory) Dim value As AutoFormsRunResult value = instance.Run(fileName, categories)`

C#
public AutoFormsRunResult Run( string fileName, List<IMasterFormsCategory> categories )

C++/CLI
public: AutoFormsRunResult^ Run( String^ fileName, List<IMasterFormsCategory>^ categories )

Parameters

fileName: A String containing the name of the unknown form image file.
categories: List of Master Forms categories to use in comaprison, pass null or empty to use all Master Forms in the repository.

Return Value

Returns the results of the recognition and processing if the form is recognized, otherwise it returns null. If the Master Form has no processing field, AutoFormsRunResult.FormFields will be null.

Example

Visual Basic Copy Code

Visual Basic	Copy Code
Public Sub AutoFormRunFile() RasterCodecs.Startup() Dim root As String = LeadtoolsExamples.Common.ImagesPath.Path + "Forms\FormsDemo\OCR_Test" Dim codecs_Renamed As RasterCodecs = New RasterCodecs() 'create repository Dim repository As DiskMasterFormsRepository = New DiskMasterFormsRepository(codecs_Renamed, root) Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False) ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing) BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d Or BarcodeMajorTypeFlags.Barcodes2dRead Or BarcodeMajorTypeFlags.BarcodesDatamatrixRead Or BarcodeMajorTypeFlags.BarcodesPdfRead Or BarcodeMajorTypeFlags.BarcodesQrRead) Dim engineBarcode As BarcodeEngine = New BarcodeEngine() 'create AutoForm Engine Dim autoEngine As AutoFormsEngine = New AutoFormsEngine(repository, ocrEngine, engineBarcode, AutoFormsRecognitionManager.Ocr Or AutoFormsRecognitionManager.Default, 30, 80, True) 'recognize and process the form Dim result As AutoFormsRunResult = autoEngine.Run(LeadtoolsExamples.Common.ImagesPath.Path + "Forms\Images\FCC-107_OCR_Filled.tif", Nothing) If result Is Nothing Then Return End If End Using RasterCodecs.Shutdown() End Sub

Public Sub AutoFormRunFile()

   RasterCodecs.Startup()

   Dim root As String = LeadtoolsExamples.Common.ImagesPath.Path + "Forms\FormsDemo\OCR_Test"



   Dim codecs_Renamed As RasterCodecs = New RasterCodecs()

   'create repository

   Dim repository As DiskMasterFormsRepository = New DiskMasterFormsRepository(codecs_Renamed, root)



   Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False)

      ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing)

      BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d Or BarcodeMajorTypeFlags.Barcodes2dRead Or BarcodeMajorTypeFlags.BarcodesDatamatrixRead Or BarcodeMajorTypeFlags.BarcodesPdfRead Or BarcodeMajorTypeFlags.BarcodesQrRead)

      Dim engineBarcode As BarcodeEngine = New BarcodeEngine()



      'create AutoForm Engine

      Dim autoEngine As AutoFormsEngine = New AutoFormsEngine(repository, ocrEngine, engineBarcode, AutoFormsRecognitionManager.Ocr Or AutoFormsRecognitionManager.Default, 30, 80, True)



      'recognize and process the form

      Dim result As AutoFormsRunResult = autoEngine.Run(LeadtoolsExamples.Common.ImagesPath.Path + "Forms\Images\FCC-107_OCR_Filled.tif", Nothing)

      If result Is Nothing Then

         Return

      End If

   End Using

   RasterCodecs.Shutdown()

End Sub

C# Copy Code

C#	Copy Code
public void AutoFormRunFile() { RasterCodecs.Startup(); string root = LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\FormsDemo\OCR_Test"; RasterCodecs codecs = new RasterCodecs(); //create repository DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false)) { ocrEngine.Startup(null, null, null, null); BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d \| BarcodeMajorTypeFlags.Barcodes2dRead \| BarcodeMajorTypeFlags.BarcodesDatamatrixRead \| BarcodeMajorTypeFlags.BarcodesPdfRead \| BarcodeMajorTypeFlags.BarcodesQrRead); BarcodeEngine barcodeEngine = new BarcodeEngine(); //create AutoForm Engine AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine, AutoFormsRecognitionManager.Ocr \| AutoFormsRecognitionManager.Default, 30, 80, true); //recognize and process the form AutoFormsRunResult result = autoEngine.Run(LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\Images\FCC-107_OCR_Filled.tif", null); if(result == null) return; } RasterCodecs.Shutdown(); }

public void AutoFormRunFile() 
{ 
   RasterCodecs.Startup(); 
 
   string root = LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\FormsDemo\OCR_Test"; 
   RasterCodecs codecs = new RasterCodecs(); 
   //create repository 
   DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); 
 
   using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false)) 
   { 
      ocrEngine.Startup(null, null, null, null); 
      BarcodeEngine.Startup(BarcodeMajorTypeFlags.Barcodes1d | BarcodeMajorTypeFlags.Barcodes2dRead | BarcodeMajorTypeFlags.BarcodesDatamatrixRead | BarcodeMajorTypeFlags.BarcodesPdfRead | BarcodeMajorTypeFlags.BarcodesQrRead); 
      BarcodeEngine barcodeEngine = new BarcodeEngine(); 
 
      //create AutoForm Engine 
      AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine, AutoFormsRecognitionManager.Ocr | AutoFormsRecognitionManager.Default, 30, 80, true); 
 
      //recognize and process the form 
      AutoFormsRunResult result = autoEngine.Run(LeadtoolsExamples.Common.ImagesPath.Path +@"Forms\Images\FCC-107_OCR_Filled.tif", null); 
      if(result == null) 
         return; 
   } 
   RasterCodecs.Shutdown(); 
}

Remarks

This method automatically recognizes the unknown form and process its fields at the same time.

The fileName should have all form pages.

If RecognizeFirstPageOnly is true, the recognition will be performed based on the first page only, if it is false the recognition will be performed over all the form pages.

If the form is not recognized it will return null, if the Master Form of the form type has no field then AutoFormsRunResult.FormFields will be null.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

Leadtools.Forms.Auto	Requires Document/Medical product license \| Send comments on this topic. \| Back to Introduction - All Topics \| Help Version 16.5.9.25
Run(String,Generic List) Method
See Also Example